home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / basic / preqlb.exe / PREQLB.DOC < prev    next >
Text File  |  1991-05-22  |  13KB  |  267 lines
  1.                                   PreQLB 2.0
  2.                      Copyright (c) 1989-1991 MicroHelp Inc.
  3.  
  4. Licensing:
  5.      This program is Copyrighted by MicroHelp Inc. and was originally
  6.      released in our QB-Pro Volume 8.  It is now being placed into the
  7.      Public Domain to assist you in creating your quick libraries.
  8.      This program can be freely distributed as long as it is not modified
  9.      in any way. The PreQLB.zip file should contain the current executable
  10.      file and this PREQLB.DOC file.  If you discover any problems with this
  11.      program we definitely want to know about them; however, only registered
  12.      users of MicroHelp products can receive tech support on this program.
  13.  
  14.      If you want further information on our line of BASIC add-in libraries
  15.      and other products, please call us at 1-800-922-3383 or in GA at
  16.      (404) 552-0565.  If you discover a problem with PreQLB, you can write
  17.      to us at 4636 Huntridge Dr.  Roswell, GA 30075.
  18.  
  19.  
  20. Creating Quick Libraries with PREQLB
  21.  
  22.        PREQLB.EXE is used to automatically build a Quick
  23.      library containing all the "external" routines needed by a
  24.      specific program.
  25.  
  26.        PREQLB parses the specified BASIC source code file(s),
  27.      checking for statements that identify the names of external
  28.      routines used in your program. The external references are
  29.      placed into a special object module, having a ".BQL"
  30.      extension.
  31.  
  32.        All of the externals that are required by your program are
  33.      extracted from a list of specified .LIB files to create the
  34.      Quick library. In addition, you can pass to it the names of
  35.      object modules that should be included in the QLB, using the
  36.      #TrailingObject command described below.
  37.  
  38.        PREQLB can be operated from the command line or via dialog
  39.      mode.
  40.  
  41. PREQLB and Command Line Mode
  42.  
  43.      The syntax for command line mode is:
  44.  
  45.                       PREQLB [?] [Filename] [/L] [/Q]
  46.  
  47.        Passing the "?" will display a help screen that gives the
  48.      proper syntax and a brief usage summary.
  49.  
  50.        "Filename" is the name of your BASIC source file. It must
  51.      be in "text" format, as opposed to "fast-load" format. You
  52.      may omit the extension (.BAS) if your program has that
  53.      extension, or if there is a ".MAK" file associated with
  54.      "Filename".
  55.  
  56.      PREQLB looks for files in the following order:
  57.  
  58. \    Filename.MAK - If found, PREQLB will process every
  59.      module listed in the file, including the main program.
  60.                               
  61. \    If a .MAK file is not found, PREQLB looks for
  62.      Filename.BAS. If your file has an extension other than .MAK
  63.      or .BAS, you must pass the complete file name on the command
  64.      line, including the extension.
  65.                               
  66. \    Additionally, PREQLB will look for a Filename.CFG file.
  67.      This configuration file is created when you use Dialog Mode
  68.      (explained under PREQLB and Dialog Mode on page 3) and
  69.      contains the names of the source file (or .MAK file), the
  70.      Quick library support library, the Quick library name, and
  71.      up to twenty additional LINK libraries, along with their
  72.      respective paths.
  73.  
  74.      While parsing the file(s), PREQLB looks for three special
  75.      pre-processing commands embedded in a REMark, just like
  76.      metacommands. Here's the syntax for the commands, shown in
  77.      example form:
  78.  
  79.      '#Libraries: 'C:\PDS\LIB\MUSCLE'
  80.      '#SupportLib: 'C:\PDS\LIB\QBXQLB'          'for PDS
  81.      '#TrailingObject: 'C:\PDS\OBJ\MHSUPFR'
  82.  
  83.      CAUTION: The apostrophes (') surrounding file names are
  84.      required.
  85.  
  86.      '#Libraries
  87.  
  88.        The #Libraries command refers to LINK libraries (.LIB file
  89.      extension), that contain the external routines referenced in
  90.      your program.
  91.  
  92.        You may specify up to 20 #Libraries in your source files.
  93.      Those in excess of 20 are ignored.
  94.  
  95.      '#SupportLib
  96.  
  97.        The #SupportLib command refers to the Quick library
  98.      support library. IMPORTANT: See page 2 of the on-line help screens
  99.      for the name to use with your compiler.
  100.  
  101.        If there is more than one #SupportLib statement, only the
  102.      last one is used.
  103.  
  104.      '#TrailingObject
  105.  
  106.        The #TrailingObject command allows you to pass the name of
  107.      any object modules that are to be unconditionally included
  108.      in your Quick library. You can use this command to include
  109.      customized object modules for individual programs, without
  110.      having to remove the object module with the same name from
  111.      your LINK library.
  112.  
  113.        You may specify up to 20 #TrailingObject modules in your
  114.      source files. Those in excess of 20 are ignored.
  115.  
  116. Switches
  117.  
  118.        The /L switch causes PREQLB to create an ASCII text file
  119.      containing the names of all the external routines in your
  120.      program. This list file will have the same name as
  121.      "Filename" (your program), with an extension of ".LST".
  122.  
  123.        The /Q switch instructs PREQLB to process $INCLUDE files
  124.      only once. If your program has multiple modules, and the
  125.      same $INCLUDE file is specified in more than one of the
  126.      modules, the /Q switch tells PREQLB to search for externals
  127.      in this $INCLUDE file only the first time that it is
  128.      processed. If you receive an "Unresolved External" error
  129.      message from the linker when building the .QLB, try running
  130.      PREQLB without the /Q switch.
  131.  
  132. PREQLB and Dialog Mode
  133.  
  134.        If you run PREQLB with no command line information, PREQLB
  135.      will prompt you for the information it needs to build a
  136.      Quick library for you.
  137.  
  138.        The only fields that must be filled in are the source file
  139.      name and the support library name. All other fields are
  140.      optional.
  141.  
  142.        New with version 2.0 is the dialog box interface. To change
  143.      fields use the TAB key to move "forward", Shift-TAB to move
  144.      "backwards" or ALT-[highlighted letter] to jump to a specific
  145.      field.  The "Build QLB" command button is highlighted by default,
  146.      and pressing the enter key at any time will cause the Quick Library
  147.      to be built. For Help, you can press ALT-H or click on the Help
  148.      command button.  Pressing the ESCape key or clicking on the Cancel
  149.      command button will exit PreQLB.
  150.                                      
  151.        You can enter the name of the source or .MAK file,
  152.      the QLB support library, up to five link libraries, and the
  153.      output QLB name.  If you do not enter a name for the Quick
  154.      Library, it will named the same as your source/make file with
  155.      the .QLB extension.
  156.  
  157.        The source file is the name of your source or .MAK file,
  158.      including the path, if desired. If your source code has a
  159.      .BAS or .MAK extension, then the extension is not required.
  160.  
  161.        You can also select the /Q and /L option switches
  162.      explained under "Switches", above.
  163.  
  164.        You can save the current configuration information as your
  165.      "Master" configuration file by selecting the "Save as Master
  166.      CFG" command button on the bottom of the screen.  This command
  167.      button can be selected by moving to the field with the TAB
  168.      button and pressing enter, pressing ALT-M or placing the mouse
  169.      cursor over the command button and pressing the left mouse button.
  170.      A file named PREQDFLT.CFG will be created in the same directory as
  171.      PREQLB.EXE saving the Link and support library information.  If you
  172.      start PreQLB from the command line, it will check for the presence
  173.      of this file and use these values as its default.  If you are using
  174.      the pre-processing commands mentioned above, they are handled in
  175.      the following manner.  '#SupportLib will overwrite any existing
  176.      values with the LAST '#SupportLib value encountered being used. Any
  177.      '#Libraries or '#TrailingObject variables encountered will be
  178.       APPENDED to whatever may exist in the default configuration file.
  179.  
  180.        Whenever PreQLB parses a module(s), it creates a configuration
  181.      file for that program with the name of <SourceFile>.CFG. This
  182.